# Copyright 2020 Huawei Technologies Co., Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ============================================================================

"""Component that comparing gradients with baseline functions."""

from ...components.icomponent import IVerifierComponent
from ...utils.compare_util import compare
from ...utils import keyword

class CompareGradientWithVC(IVerifierComponent):
    """
    Compare the result with baseline functions configured in 'compare_gradient_with' config item.

    Examples:
    'desc_expect': {
        'compare_with': [
            matmul_np,
            matmul_tf
        ],
        'compare_gradient_with': [
            matmul_gradient_tf
        ],
        'max_error': 1e-3
    }
    """
    def verify(self, expect, func_result, verification_set):
        compare(expect, func_result, baseline=keyword.compare_gradient_with)
